/*
 * Copyright 2022-2025 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.instancio.generators;

import org.instancio.generator.specs.EanGeneratorSpec;
import org.instancio.generator.specs.IsbnGeneratorSpec;
import org.instancio.generators.bra.BraIdGenerators;
import org.instancio.generators.can.CanIdGenerators;
import org.instancio.generators.pol.PolIdGenerators;
import org.instancio.generators.rus.RusIdGenerators;
import org.instancio.generators.usa.UsaIdGenerators;

/**
 * Contains built-in generators for various types of identifiers.
 *
 * @since 2.11.0
 */
public interface IdGenerators {

    /**
     * Generates European Article Number (EAN).
     *
     * @return API builder reference
     * @since 2.11.0
     */
    EanGeneratorSpec ean();

    /**
     * Generates ISBN numbers.
     *
     * @return API builder reference
     * @since 2.11.0
     */
    IsbnGeneratorSpec isbn();

    /**
     * Provides access to identifier generators for Canada.
     *
     * @return built-in id generators
     * @since 3.1.0
     */
    CanIdGenerators can();

    /**
     * Provides access to identifier generators for Poland.
     *
     * @return built-in id generators
     * @since 3.1.0
     */
    PolIdGenerators pol();

    /**
     * Provides access to identifier generators for the USA.
     *
     * @return built-in id generators
     * @since 3.1.0
     */
    UsaIdGenerators usa();

    /**
     * Provides access to identifier generators for Brazil.
     *
     * @return built-in id generators
     * @since 5.0.0
     */
    BraIdGenerators bra();

    /**
     * Provides access to identifier generators for Russia.
     *
     * @return built-in id generators
     * @since 5.0.0
     */
    RusIdGenerators rus();
}
